PUT Channels Order

Overview

The table below provides key details about the PUT method for updating the order of channels.

Update Channels Order
Method	PUT
URL or Endpoint	/api/v1/projectId/channels/order
Headers	Authorization
Content Type	application/json
Parameters	projectId

The description of the URL parameter is as follows:

Request Body

{
  "items": [
    {
      "id": "string",
      "orderNumber": 0
    }
  ]
}

Information about the fields that appear on body request are displayed in the table below.

Field Name	Type	Description
items	array[Object]	Array that contain objects
id	string	Unique identifier for the item
orderNumber	integer($int32)	Order number of the item

{
  "success": true,
  "errors": [],
  "messages": [],
  "result": true,
  "resultInfo": null,
  "statusCode": 200
}

Information about the fields that appear when you receive the response are displayed in the table below.

Field Name	Type	Description
success	bool	If the response is successful it will return true. Otherwise will return false.
errors	array[]	Indicates if there was an error.
messages	array[]	Returns the response message from back-end.
result	bool	Return a boolean value based on the result of the response.
resultInfo	string	Returns extra information about the result.
statusCode	integer($int32)	Returns the HTTP Status Code.

If the action is successful, the service sends back an HTTP 200 or 201 response.

For information about the errors that are common to all actions, see Common Errors: